/*
 * Copyright (c) 2017 NCIC, Institute of Computing Technology, Chinese Academy of Sciences
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.ncic.bioinfo.sparkseq.algorithms.data.vcf;

import htsjdk.samtools.util.AbstractIterator;
import htsjdk.samtools.util.CloserUtil;
import htsjdk.tribble.readers.LineIterator;
import org.ncic.bioinfo.sparkseq.data.common.VcfHeaderInfo;
import org.ncic.bioinfo.sparkseq.transfer.CollectionConverter;

import java.io.Closeable;
import java.io.IOException;
import java.util.Arrays;
import java.util.Iterator;

/**
 * Author: wbc
 */
public class VCFHeaderLineIterable extends AbstractIterator<String> implements LineIterator, Closeable {

    private final Iterator<String> vcfLinesIter;

    public VCFHeaderLineIterable(final VcfHeaderInfo vcfHeaderInfo) {
        this.vcfLinesIter = CollectionConverter.asJavaList(vcfHeaderInfo.getHeaderLines()).iterator();
    }

    public VCFHeaderLineIterable(String[] vcfHeaderLines) {
        this.vcfLinesIter = Arrays.asList(vcfHeaderLines).iterator();
    }

    @Override
    protected String advance() {
        if (!vcfLinesIter.hasNext()) {
            return null;
        } else {
            return vcfLinesIter.next();
        }
    }

    @Override
    public void close() throws IOException {
        CloserUtil.close(vcfLinesIter);
    }
}
